.. _cmmSxGetCorrection:

cmmSxGetCorrection
=====================
---------------------

SYNOPSYS
```````````

.. code-block:: none

    VT_I4 cmmSxGetCorrection(
        [in] VT_I4 Axis, [out] VT_PI4 CorrMode, [out] VT_PR8 CorrAmount, [out] VT_PR8 CorrVel, [out] VT_PI4 CntrMask
        )


DESCRIPTION
`````````````

- cmmSxGetCorrection() 함수는 백래쉬/슬립 보정에 대한 현재 설정값을 읽어들이는 함수입니다.

PARAMETER
```````````

- Axis: 축번호. 축번호는 상수값으로 [cmX1] 부터 0 번째 축을 기준 축으로 임의의 축을 설정할 수 있습니다.

\

- CorrMode : cmmSxSetCorrection 함수의 인자이며, 보정 모드의 설정값은 다음과 같습니다.


.. csv-table::
    :widths: 10 85
    :header-rows: 1
    :stub-columns: 0

    BIT No., Meaning
    0 (cmCORR_DIS), 보정기능을 비활성화 상태입니다.
    1 (cmCORR_BACK), 보정모드를 백래쉬 보정모드로 동작중입니다.
    2 (cmCORR_SLIP), 보정모드를 슬립 보정모드로 동작중입니다.


- CorrAmount : CorrAmount : cmmSxGetCorrection 함수의 인자이며, 보정 펄스의 수를 반환합니다.      

\

- CorrVel : ccmmSxGetCorrection 함수의 인자이며, 보정펄스의 주파수를 반환합니다.

\

- CntrMask : cmmSxGetCorrection 함수의 인자이며, 보정펄스가 출력되는 동안에 각 카운터의 동작여부를 비트별로
  반환합니다. 각 비트가 나타내느 값은 아래 표를 참고 하십시오.

.. csv-table::
    :widths: 10 85
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    BIT0, 1: 보정펄스 출력시에 Command Counter 가 동작하는 모드입니다.
    BIT1, 1: 보정펄스 출력시에 FeedBack Counter 가 동작하는 모드입니다.
    BIT2, 1: 보정펄스 출력시에 Deviation Counter 가 동작하는 모드입니다.
    BIT3, 1: 보정펄스 출력시에 General Counter 가 동작하는 모드입니다.


RETURN VALUE
`````````````

+--------------+-----------+
| Value        | Meaning   |
+==============+===========+
| 음수         | 수행 실패 |
+--------------+-----------+
| cmERR_NONE   | 수행 성공 |
+--------------+-----------+


EXAMPLE 1,2 
`````````````

- cmmSxSetCorrection을 참고해주세요.

.. seealso:: :ref:`cmmSxSetCorrection`